<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityHandlerImpl xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityHandlerImpl.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-rest/xref/org/sakaiproject/entitybus/rest/EntityHandlerImpl.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityHandler.java - entity-broker - Apr 6, 2008 9:03:03 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2007, 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.<strong>rest</strong>;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.ByteArrayInputStream;
<a name="24" href="#24">24</a>  <strong>import</strong> java.io.ByteArrayOutputStream;
<a name="25" href="#25">25</a>  <strong>import</strong> java.io.IOException;
<a name="26" href="#26">26</a>  <strong>import</strong> java.io.InputStream;
<a name="27" href="#27">27</a>  <strong>import</strong> java.io.OutputStream;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.ArrayList;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Date;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.List;
<a name="31" href="#31">31</a>  <strong>import</strong> java.util.Map;
<a name="32" href="#32">32</a>  <strong>import</strong> java.util.Map.Entry;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <strong>import</strong> javax.servlet.http.HttpServletRequest;
<a name="35" href="#35">35</a>  <strong>import</strong> javax.servlet.http.HttpServletResponse;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBroker;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="44" href="#44">44</a>  <strong>import</strong> org.sakaiproject.entitybus.access.AccessFormats;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.entitybus.access.AccessViews;
<a name="46" href="#46">46</a>  <strong>import</strong> org.sakaiproject.entitybus.access.EntityViewAccessProvider;
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.entitybus.access.EntityViewAccessProviderManager;
<a name="48" href="#48">48</a>  <strong>import</strong> org.sakaiproject.entitybus.access.HttpServletAccessProvider;
<a name="49" href="#49">49</a>  <strong>import</strong> org.sakaiproject.entitybus.access.HttpServletAccessProviderManager;
<a name="50" href="#50">50</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProvider;
<a name="51" href="#51">51</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderManager;
<a name="52" href="#52">52</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.annotations.EntityLastModified;
<a name="53" href="#53">53</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsExecutable;
<a name="54" href="#54">54</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Createable;
<a name="55" href="#55">55</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Deleteable;
<a name="56" href="#56">56</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.InputTranslatable;
<a name="57" href="#57">57</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Inputable;
<a name="58" href="#58">58</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.OutputFormattable;
<a name="59" href="#59">59</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Outputable;
<a name="60" href="#60">60</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RequestHandler;
<a name="61" href="#61">61</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RequestInterceptor;
<a name="62" href="#62">62</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Redirectable;
<a name="63" href="#63">63</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Updateable;
<a name="64" href="#64">64</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.ActionReturn;
<a name="65" href="#65">65</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.CustomAction;
<a name="66" href="#66">66</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.EntityData;
<a name="67" href="#67">67</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="68" href="#68">68</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestGetterWrite;
<a name="69" href="#69">69</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorage;
<a name="70" href="#70">70</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorageWrite;
<a name="71" href="#71">71</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Search;
<a name="72" href="#72">72</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityEncodingException;
<a name="73" href="#73">73</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityException;
<a name="74" href="#74">74</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityNotFoundException;
<a name="75" href="#75">75</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.FormatUnsupportedException;
<a name="76" href="#76">76</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRequestHandler;
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>  <strong>import</strong> org.sakaiproject.entitybus.util.ClassLoaderReporter;
<a name="79" href="#79">79</a>  <strong>import</strong> org.sakaiproject.entitybus.util.EntityDataUtils;
<a name="80" href="#80">80</a>  <strong>import</strong> org.sakaiproject.entitybus.util.EntityResponse;
<a name="81" href="#81">81</a>  <strong>import</strong> org.sakaiproject.entitybus.util.TemplateParseUtil;
<a name="82" href="#82">82</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpRESTUtils;
<a name="83" href="#83">83</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpResponse;
<a name="84" href="#84">84</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.LazyResponseOutputStream;
<a name="85" href="#85">85</a>  <strong>import</strong> org.sakaiproject.entitybus.util.http.HttpRESTUtils.Method;
<a name="86" href="#86">86</a>  <strong>import</strong> org.sakaiproject.entitybus.util.request.RequestUtils;
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="89" href="#89">89</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldnameNotFoundException;
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>  <em>/**<em>*</em></em>
<a name="92" href="#92">92</a>  <em> * Implementation of the handler for the EntityBroker system&lt;br/></em>
<a name="93" href="#93">93</a>  <em> * This handles all the processing of incoming requests (http based) and includes</em>
<a name="94" href="#94">94</a>  <em> * method to process the request data and ensure classloader safety</em>
<a name="95" href="#95">95</a>  <em> * </em>
<a name="96" href="#96">96</a>  <em> * @author Aaron Zeckoski (aaronz@vt.edu)</em>
<a name="97" href="#97">97</a>  <em> */</em>
<a name="98" href="#98">98</a>  @SuppressWarnings(<span class="string">"deprecation"</span>)
<a name="99" href="#99">99</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a> implements EntityRequestHandler {
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a>     <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(EntityHandlerImpl.<strong>class</strong>);
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <em>/**<em>*</em></em>
<a name="104" href="#104">104</a> <em>     * Empty constructor</em>
<a name="105" href="#105">105</a> <em>     */</em>
<a name="106" href="#106">106</a>     <strong>protected</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a>() { }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em>/**<em>*</em></em>
<a name="109" href="#109">109</a> <em>     * Full constructor</em>
<a name="110" href="#110">110</a> <em>     */</em>
<a name="111" href="#111">111</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a>(EntityProviderManager entityProviderManager,
<a name="112" href="#112">112</a>             EntityBrokerManager entityBrokerManager, <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager,
<a name="113" href="#113">113</a>             <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> entityDescriptionManager,
<a name="114" href="#114">114</a>             EntityViewAccessProviderManager entityViewAccessProviderManager,
<a name="115" href="#115">115</a>             RequestGetterWrite requestGetter, <a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a> entityActionsManager,
<a name="116" href="#116">116</a>             <a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a> entityRedirectsManager, <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> entityBatchHandler,
<a name="117" href="#117">117</a>             RequestStorageWrite requestStorage) {
<a name="118" href="#118">118</a>         <strong>super</strong>();
<a name="119" href="#119">119</a>         <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="120" href="#120">120</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="121" href="#121">121</a>         <strong>this</strong>.entityEncodingManager = entityEncodingManager;
<a name="122" href="#122">122</a>         <strong>this</strong>.entityDescriptionManager = entityDescriptionManager;
<a name="123" href="#123">123</a>         <strong>this</strong>.entityViewAccessProviderManager = entityViewAccessProviderManager;
<a name="124" href="#124">124</a>         <strong>this</strong>.requestGetter = requestGetter;
<a name="125" href="#125">125</a>         <strong>this</strong>.entityActionsManager = entityActionsManager;
<a name="126" href="#126">126</a>         <strong>this</strong>.entityRedirectsManager = entityRedirectsManager;
<a name="127" href="#127">127</a>         <strong>this</strong>.requestStorage = requestStorage;
<a name="128" href="#128">128</a>         setEntityBatchHandler(entityBatchHandler);
<a name="129" href="#129">129</a>         init();
<a name="130" href="#130">130</a>     }
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <strong>public</strong> <strong>void</strong> init() {
<a name="133" href="#133">133</a>         log.info(<span class="string">"init complete"</span>);
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <strong>private</strong> EntityProviderManager entityProviderManager;
<a name="137" href="#137">137</a>     <strong>public</strong> <strong>void</strong> setEntityProviderManager(EntityProviderManager entityProviderManager) {
<a name="138" href="#138">138</a>         <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="139" href="#139">139</a>     }
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a>     <strong>private</strong> EntityBrokerManager entityBrokerManager;
<a name="142" href="#142">142</a>     <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="143" href="#143">143</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="144" href="#144">144</a>     }
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager;
<a name="147" href="#147">147</a>     <strong>public</strong> <strong>void</strong> setEntityEncodingManager(<a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager) {
<a name="148" href="#148">148</a>         <strong>this</strong>.entityEncodingManager = entityEncodingManager;
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> entityDescriptionManager;
<a name="152" href="#152">152</a>     <strong>public</strong> <strong>void</strong> setEntityDescriptionManager(<a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> entityDescriptionManager) {
<a name="153" href="#153">153</a>         <strong>this</strong>.entityDescriptionManager = entityDescriptionManager;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <strong>private</strong> HttpServletAccessProviderManager accessProviderManager;
<a name="157" href="#157">157</a>     <strong>public</strong> <strong>void</strong> setAccessProviderManager(HttpServletAccessProviderManager accessProviderManager) {
<a name="158" href="#158">158</a>         <strong>this</strong>.accessProviderManager = accessProviderManager;
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>     <strong>private</strong> EntityViewAccessProviderManager entityViewAccessProviderManager;
<a name="162" href="#162">162</a>     <strong>public</strong> <strong>void</strong> setEntityViewAccessProviderManager(
<a name="163" href="#163">163</a>             EntityViewAccessProviderManager entityViewAccessProviderManager) {
<a name="164" href="#164">164</a>         <strong>this</strong>.entityViewAccessProviderManager = entityViewAccessProviderManager;
<a name="165" href="#165">165</a>     }
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>     <strong>private</strong> RequestGetterWrite requestGetter;
<a name="168" href="#168">168</a>     <strong>public</strong> <strong>void</strong> setRequestGetter(RequestGetterWrite requestGetter) {
<a name="169" href="#169">169</a>         <strong>this</strong>.requestGetter = requestGetter;
<a name="170" href="#170">170</a>     }
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a> entityActionsManager;
<a name="173" href="#173">173</a>     <strong>public</strong> <strong>void</strong> setEntityActionsManager(<a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a> entityActionsManager) {
<a name="174" href="#174">174</a>         <strong>this</strong>.entityActionsManager = entityActionsManager;
<a name="175" href="#175">175</a>     }
<a name="176" href="#176">176</a> 
<a name="177" href="#177">177</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a> entityRedirectsManager;
<a name="178" href="#178">178</a>     <strong>public</strong> <strong>void</strong> setEntityRedirectsManager(<a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a> entityRedirectsManager) {
<a name="179" href="#179">179</a>         <strong>this</strong>.entityRedirectsManager = entityRedirectsManager;
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> entityBatchHandler;
<a name="183" href="#183">183</a>     <strong>public</strong> <strong>void</strong> setEntityBatchHandler(<a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> entityBatchHandler) {
<a name="184" href="#184">184</a>         <strong>this</strong>.entityBatchHandler = entityBatchHandler;
<a name="185" href="#185">185</a>         <em class="comment">// NOTE: this is somewhat tricky but it avoids issues related to circular dependencies</em>
<a name="186" href="#186">186</a>         <strong>this</strong>.entityBatchHandler.setEntityRequestHandler(<strong>this</strong>);
<a name="187" href="#187">187</a>     }
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <strong>private</strong> RequestStorageWrite requestStorage;
<a name="190" href="#190">190</a>     <strong>public</strong> <strong>void</strong> setRequestStorage(RequestStorageWrite requestStorage) {
<a name="191" href="#191">191</a>         <strong>this</strong>.requestStorage = requestStorage;
<a name="192" href="#192">192</a>     }
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a> 
<a name="195" href="#195">195</a>     <em class="comment">// allow the servlet name to be more flexible</em>
<a name="196" href="#196">196</a>     <strong>private</strong> String servletContext;
<a name="197" href="#197">197</a>     <strong>public</strong> String getServletContext() {
<a name="198" href="#198">198</a>         <strong>if</strong> (<strong>this</strong>.servletContext == <strong>null</strong>) {
<a name="199" href="#199">199</a>             <strong>return</strong> RequestUtils.getServletContext(<strong>null</strong>);
<a name="200" href="#200">200</a>         }
<a name="201" href="#201">201</a>         <strong>return</strong> <strong>this</strong>.servletContext;
<a name="202" href="#202">202</a>     }
<a name="203" href="#203">203</a>     <strong>public</strong> <strong>void</strong> setServletContext(String servletContext) {
<a name="204" href="#204">204</a>         <strong>if</strong> (servletContext != <strong>null</strong>) {
<a name="205" href="#205">205</a>             <strong>this</strong>.servletContext = servletContext;
<a name="206" href="#206">206</a>             entityRedirectsManager.setServletContext(servletContext);
<a name="207" href="#207">207</a>             entityBatchHandler.setServletContext(servletContext);
<a name="208" href="#208">208</a>         }
<a name="209" href="#209">209</a>     }
<a name="210" href="#210">210</a> 
<a name="211" href="#211">211</a>     
<a name="212" href="#212">212</a>     <em>/**<em>*</em></em>
<a name="213" href="#213">213</a> <em>     * If this param is set then the sakai session for the current request is set to this rather than establishing one,</em>
<a name="214" href="#214">214</a> <em>     * will allow changing the session as well</em>
<a name="215" href="#215">215</a> <em>     */</em>
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="218" href="#218">218</a> <em class="comment">     * @see org.sakaiproject.entitybus.EntityRequestHandler#handleEntityAccess(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)</em>
<a name="219" href="#219">219</a> <em class="comment">     */</em>
<a name="220" href="#220">220</a>     <strong>public</strong> String handleEntityAccess(HttpServletRequest req, HttpServletResponse res, String path) {
<a name="221" href="#221">221</a>         <em class="comment">// set the servlet context if not set</em>
<a name="222" href="#222">222</a>         <strong>if</strong> (<strong>this</strong>.servletContext == <strong>null</strong>) {
<a name="223" href="#223">223</a>             setServletContext( RequestUtils.getServletContext(req) );
<a name="224" href="#224">224</a>         }
<a name="225" href="#225">225</a> 
<a name="226" href="#226">226</a>         <em class="comment">// get the path info if not set</em>
<a name="227" href="#227">227</a>         <strong>if</strong> (path == <strong>null</strong>) {
<a name="228" href="#228">228</a>             path = req.getPathInfo();
<a name="229" href="#229">229</a>         }
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>         String handledReference = <strong>null</strong>;
<a name="232" href="#232">232</a> 
<a name="233" href="#233">233</a>         <em class="comment">// special handling in case the session ID is sent in the request </em>
<a name="234" href="#234">234</a>         <em class="comment">// (allows setting up and reusing a session over and over without holding cookies)</em>
<a name="235" href="#235">235</a>         <strong>if</strong> (entityBrokerManager.getExternalIntegrationProvider() != <strong>null</strong>) {
<a name="236" href="#236">236</a>             <strong>try</strong> {
<a name="237" href="#237">237</a>                 entityBrokerManager.getExternalIntegrationProvider().handleUserSessionKey(req);
<a name="238" href="#238">238</a>             } <strong>catch</strong> (Exception e) {
<a name="239" href="#239">239</a>                 log.warn(<span class="string">"External handleUserSessionKey method failed, continuing...: "</span> + e);
<a name="240" href="#240">240</a>             }
<a name="241" href="#241">241</a>         }
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>         <strong>if</strong> (path == <strong>null</strong> || <span class="string">""</span>.equals(path) || <span class="string">"/"</span>.equals(path)) {
<a name="244" href="#244">244</a>             <em class="comment">// SPECIAL handling for empty path</em>
<a name="245" href="#245">245</a>             res.setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY);
<a name="246" href="#246">246</a>             <strong>try</strong> {
<a name="247" href="#247">247</a>                 res.sendRedirect( res.encodeRedirectURL(getServletContext() + SLASH_DESCRIBE) );
<a name="248" href="#248">248</a>             } <strong>catch</strong> (IOException e) {
<a name="249" href="#249">249</a>                 <em class="comment">// should never happen</em>
<a name="250" href="#250">250</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Could not encode the redirect URL"</span>);
<a name="251" href="#251">251</a>             }
<a name="252" href="#252">252</a>             <em class="comment">// immediate exit from redirect</em>
<a name="253" href="#253">253</a>             <strong>return</strong> <span class="string">"/"</span>;
<a name="254" href="#254">254</a>         } <strong>else</strong> {
<a name="255" href="#255">255</a>             <em class="comment">// regular handling for direct URLs</em>
<a name="256" href="#256">256</a>             <strong>if</strong> ( (SLASH_DESCRIBE).equals(path) 
<a name="257" href="#257">257</a>                     || path.startsWith(SLASH_DESCRIBE + EntityReference.PERIOD)) {
<a name="258" href="#258">258</a>                 <em class="comment">// SPECIAL handling for the describe all URL</em>
<a name="259" href="#259">259</a>                 String format = TemplateParseUtil.findExtension(path)[2];
<a name="260" href="#260">260</a>                 <strong>if</strong> (format == <strong>null</strong>) {
<a name="261" href="#261">261</a>                     format = Formats.HTML;
<a name="262" href="#262">262</a>                 }
<a name="263" href="#263">263</a>                 RequestUtils.setResponseEncoding(format, res);
<a name="264" href="#264">264</a>                 String output = entityDescriptionManager.makeDescribeAll(format, req.getLocale()); <em class="comment">// possibly get the locale from other places?</em>
<a name="265" href="#265">265</a>                 res.setContentLength(output.getBytes().length);
<a name="266" href="#266">266</a>                 <strong>try</strong> {
<a name="267" href="#267">267</a>                     res.getWriter().write(output);
<a name="268" href="#268">268</a>                 } <strong>catch</strong> (IOException e) {
<a name="269" href="#269">269</a>                     <em class="comment">// should never happen</em>
<a name="270" href="#270">270</a>                     <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failed to put output into the response writer: "</span> + e.getMessage(), e);
<a name="271" href="#271">271</a>                 }
<a name="272" href="#272">272</a>                 res.setStatus(HttpServletResponse.SC_OK);
<a name="273" href="#273">273</a>                 handledReference = EntityView.SEPARATOR+<span class="string">""</span>;
<a name="274" href="#274">274</a>             } <strong>else</strong> {
<a name="275" href="#275">275</a>                 <em class="comment">// STANDARD processing for the incoming view</em>
<a name="276" href="#276">276</a>                 EntityView view;
<a name="277" href="#277">277</a>                 <strong>try</strong> {
<a name="278" href="#278">278</a>                     view = entityBrokerManager.parseEntityURL(path);
<a name="279" href="#279">279</a>                 } <strong>catch</strong> (IllegalArgumentException e) {
<a name="280" href="#280">280</a>                     <em class="comment">// FAILURE indicates we could not parse the reference</em>
<a name="281" href="#281">281</a>                     <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Could not parse entity path ("</span>+path+<span class="string">"): "</span> + e.getMessage(), path, HttpServletResponse.SC_BAD_REQUEST);
<a name="282" href="#282">282</a>                 }
<a name="283" href="#283">283</a> 
<a name="284" href="#284">284</a>                 <strong>if</strong> (view == <strong>null</strong>) {
<a name="285" href="#285">285</a>                     <em class="comment">// FAILURE no provider for this entity prefix</em>
<a name="286" href="#286">286</a>                     <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Could not parse the incoming path ("</span>+path+<span class="string">") and no entity provider could be found to handle the prefix"</span>, 
<a name="287" href="#287">287</a>                             path, HttpServletResponse.SC_NOT_IMPLEMENTED );
<a name="288" href="#288">288</a>                 } <strong>else</strong> <strong>if</strong> ( DESCRIBE.equals(view.getEntityReference().getId()) ) {
<a name="289" href="#289">289</a>                     <em class="comment">// SPECIAL handling for entity describe URLs</em>
<a name="290" href="#290">290</a>                     String format = TemplateParseUtil.findExtension(path)[2];
<a name="291" href="#291">291</a>                     <strong>if</strong> (format == <strong>null</strong>) {
<a name="292" href="#292">292</a>                         format = Formats.HTML;
<a name="293" href="#293">293</a>                     }
<a name="294" href="#294">294</a>                     RequestUtils.setResponseEncoding(format, res);
<a name="295" href="#295">295</a>                     String entityId = req.getParameter(<span class="string">"_id"</span>);
<a name="296" href="#296">296</a>                     <strong>if</strong> (entityId == <strong>null</strong> || <span class="string">""</span>.equals(entityId)) {
<a name="297" href="#297">297</a>                         entityId = FAKE_ID;
<a name="298" href="#298">298</a>                     }
<a name="299" href="#299">299</a>                     String output = entityDescriptionManager.makeDescribeEntity(view.getEntityReference().getPrefix(), entityId, format, req.getLocale());
<a name="300" href="#300">300</a>                     res.setContentLength(output.getBytes().length);
<a name="301" href="#301">301</a>                     <strong>try</strong> {
<a name="302" href="#302">302</a>                         res.getWriter().write(output);
<a name="303" href="#303">303</a>                     } <strong>catch</strong> (IOException e) {
<a name="304" href="#304">304</a>                         <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failed to put output into the response writer: "</span> + e.getMessage(), e);
<a name="305" href="#305">305</a>                     }
<a name="306" href="#306">306</a>                     res.setStatus(HttpServletResponse.SC_OK);
<a name="307" href="#307">307</a>                     handledReference = view.getEntityReference().getSpaceReference() + SLASH_DESCRIBE;
<a name="308" href="#308">308</a> 
<a name="309" href="#309">309</a>                 } <strong>else</strong> {
<a name="310" href="#310">310</a>                     <em class="comment">// STANDARD reference successfully parsed</em>
<a name="311" href="#311">311</a>                     String prefix = view.getEntityReference().getPrefix();
<a name="312" href="#312">312</a> 
<a name="313" href="#313">313</a>                     <em class="comment">// check for redirect</em>
<a name="314" href="#314">314</a>                     Redirectable urlConfigurable = entityProviderManager.getProviderByPrefixAndCapability(prefix, Redirectable.<strong>class</strong>);
<a name="315" href="#315">315</a>                     <strong>if</strong> (urlConfigurable != <strong>null</strong>) {
<a name="316" href="#316">316</a>                         <em class="comment">// SPECIAL check for redirect</em>
<a name="317" href="#317">317</a>                         String redirectURL = entityRedirectsManager.checkForTemplateMatch(urlConfigurable, path, req.getQueryString());
<a name="318" href="#318">318</a>                         <strong>if</strong> (redirectURL != <strong>null</strong>) {
<a name="319" href="#319">319</a>                             <em class="comment">// SPECIAL handling for redirect</em>
<a name="320" href="#320">320</a>                             <strong>if</strong> (<span class="string">""</span>.equals(redirectURL)) {
<a name="321" href="#321">321</a>                                 <em class="comment">// do nothing but return an empty response</em>
<a name="322" href="#322">322</a>                                 res.setStatus(HttpServletResponse.SC_OK);
<a name="323" href="#323">323</a>                             } <strong>else</strong> {
<a name="324" href="#324">324</a>                                 <em class="comment">// do the redirect</em>
<a name="325" href="#325">325</a>                                 log.info(<span class="string">"Entity Redirect: redirecting from ("</span>+path+<span class="string">") to ("</span>+redirectURL+<span class="string">")"</span>);
<a name="326" href="#326">326</a>                                 RequestUtils.handleURLRedirect(redirectURL, <strong>true</strong>, req, res);
<a name="327" href="#327">327</a>                             }
<a name="328" href="#328">328</a>                             <strong>return</strong> EntityView.SEPARATOR + prefix; <em class="comment">// exit here for redirects</em>
<a name="329" href="#329">329</a>                         }
<a name="330" href="#330">330</a>                     }
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>                     <em class="comment">// check for custom action</em>
<a name="333" href="#333">333</a>                     CustomAction customAction = entityActionsManager.getCustomAction(prefix, view.getPathSegment(1));
<a name="334" href="#334">334</a>                     <strong>if</strong> (customAction == <strong>null</strong>) {
<a name="335" href="#335">335</a>                         customAction = entityActionsManager.getCustomAction(prefix, view.getPathSegment(2));
<a name="336" href="#336">336</a>                     }
<a name="337" href="#337">337</a>                     <strong>if</strong> (customAction == <strong>null</strong>) {
<a name="338" href="#338">338</a>                         <em class="comment">// check to see if the entity exists</em>
<a name="339" href="#339">339</a>                         <strong>if</strong> (! entityBrokerManager.entityExists(view.getEntityReference()) ) {
<a name="340" href="#340">340</a>                             <em class="comment">// FAILURE invalid entity reference (entity does not exist)</em>
<a name="341" href="#341">341</a>                             <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Attempted to access an entity URL path ("</span> + path + <span class="string">") for an entity ("</span>
<a name="342" href="#342">342</a>                                     + view.getEntityReference() + <span class="string">") that does not exist"</span>, 
<a name="343" href="#343">343</a>                                     view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_NOT_FOUND );
<a name="344" href="#344">344</a>                         }
<a name="345" href="#345">345</a>                     } <strong>else</strong> {
<a name="346" href="#346">346</a>                         <em class="comment">// cleanup the entity reference, this has to be done because otherwise the custom action</em>
<a name="347" href="#347">347</a>                         <em class="comment">// on collections appears to be the id of an entity in the collection</em>
<a name="348" href="#348">348</a>                         EntityReference cRef = view.getEntityReference();
<a name="349" href="#349">349</a>                         <strong>if</strong> (cRef.getId().equals(customAction.action)) {
<a name="350" href="#350">350</a>                             view.setEntityReference( <strong>new</strong> EntityReference(prefix, <span class="string">""</span>) );
<a name="351" href="#351">351</a>                         }
<a name="352" href="#352">352</a>                     }
<a name="353" href="#353">353</a>                     res.setStatus(HttpServletResponse.SC_OK); <em class="comment">// default - other things can switch this later on</em>
<a name="354" href="#354">354</a> 
<a name="355" href="#355">355</a>                     <em class="comment">// store format in attribute</em>
<a name="356" href="#356">356</a>                     req.setAttribute(<span class="string">"entity-format"</span>, view.getFormat());
<a name="357" href="#357">357</a> 
<a name="358" href="#358">358</a>                     <em class="comment">// STANDARD initial processing complete</em>
<a name="359" href="#359">359</a>                     <em class="comment">// wrap in try block so that request storage is always cleaned up</em>
<a name="360" href="#360">360</a>                     <strong>try</strong> {
<a name="361" href="#361">361</a>                         <em class="comment">// store the current request and response</em>
<a name="362" href="#362">362</a>                         requestGetter.setRequest(req);
<a name="363" href="#363">363</a>                         requestGetter.setResponse(res);
<a name="364" href="#364">364</a>                         <em class="comment">// set the request variables</em>
<a name="365" href="#365">365</a>                         requestStorage.setRequestValue(RequestStorage.ReservedKeys._requestEntityReference.name(), view.getEntityReference().toString());
<a name="366" href="#366">366</a>                         requestStorage.setRequestValue(RequestStorage.ReservedKeys._requestOrigin.name(), RequestStorage.RequestOrigin.REST.name());
<a name="367" href="#367">367</a>                         requestStorage.setRequestValue(RequestStorage.ReservedKeys._requestActive.name(), <strong>true</strong>);
<a name="368" href="#368">368</a> 
<a name="369" href="#369">369</a>                         <em class="comment">// handle the before interceptor</em>
<a name="370" href="#370">370</a>                         RequestInterceptor interceptor = (RequestInterceptor) entityProviderManager.getProviderByPrefixAndCapability(prefix, RequestInterceptor.<strong>class</strong>);
<a name="371" href="#371">371</a>                         <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="372" href="#372">372</a>                             interceptor.before(view, req, res);
<a name="373" href="#373">373</a>                         }
<a name="374" href="#374">374</a> 
<a name="375" href="#375">375</a>                         <strong>if</strong> (BATCH.equals(prefix)) {
<a name="376" href="#376">376</a>                             <em class="comment">// special batch handling</em>
<a name="377" href="#377">377</a>                             <strong>if</strong> (view.getExtension() == <strong>null</strong>) {
<a name="378" href="#378">378</a>                                 <em class="comment">// default extension is JSON</em>
<a name="379" href="#379">379</a>                                 view.setExtension(Formats.JSON);
<a name="380" href="#380">380</a>                             }
<a name="381" href="#381">381</a>                             entityBatchHandler.handleBatch(view, req, res);
<a name="382" href="#382">382</a>                         } <strong>else</strong> {
<a name="383" href="#383">383</a>                             <em class="comment">// check for provider handling of this request</em>
<a name="384" href="#384">384</a>                             RequestHandler handler = (RequestHandler) entityProviderManager.getProviderByPrefixAndCapability(prefix, RequestHandler.<strong>class</strong>);
<a name="385" href="#385">385</a>                             <strong>if</strong> (handler != <strong>null</strong>) {
<a name="386" href="#386">386</a>                                 <em class="comment">// SPECIAL provider is handling this request</em>
<a name="387" href="#387">387</a>                                 handleClassLoaderAccess(handler, req, res, view);
<a name="388" href="#388">388</a>                             } <strong>else</strong> {
<a name="389" href="#389">389</a>                                 <em class="comment">// STANDARD processing of the entity request internally start here</em>
<a name="390" href="#390">390</a>                                 <em class="comment">// try to handle the request internally if possible</em>
<a name="391" href="#391">391</a>     
<a name="392" href="#392">392</a>                                 <em class="comment">// identify the type of request (input or output) and the action (will be encoded in the viewKey)</em>
<a name="393" href="#393">393</a>                                 <strong>boolean</strong> output = RequestUtils.isRequestOutput(req, view);
<a name="394" href="#394">394</a>                                 setResponseHeaders(view, res, requestStorage.getStorageMapCopy(), <strong>null</strong>);
<a name="395" href="#395">395</a>     
<a name="396" href="#396">396</a>                                 <strong>boolean</strong> handled = false;
<a name="397" href="#397">397</a>                                 <em class="comment">// PROCESS CUSTOM ACTIONS</em>
<a name="398" href="#398">398</a>                                 ActionReturn actionReturn = <strong>null</strong>;
<a name="399" href="#399">399</a>                                 <strong>if</strong> (customAction != <strong>null</strong>) {
<a name="400" href="#400">400</a>                                     <em class="comment">// SPECIAL handle the custom action</em>
<a name="401" href="#401">401</a>                                     ActionsExecutable actionProvider = entityProviderManager.getProviderByPrefixAndCapability(prefix, ActionsExecutable.<strong>class</strong>);
<a name="402" href="#402">402</a>                                     <strong>if</strong> (actionProvider == <strong>null</strong>) {
<a name="403" href="#403">403</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"The provider for prefix ("</span>+prefix+<span class="string">") cannot handle custom actions"</span>, 
<a name="404" href="#404">404</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST );
<a name="405" href="#405">405</a>                                     }
<a name="406" href="#406">406</a>                                     <em class="comment">// make sure this request is a valid type for this action</em>
<a name="407" href="#407">407</a>                                     <strong>if</strong> (customAction.viewKey != <strong>null</strong> 
<a name="408" href="#408">408</a>                                             &amp;&amp; ! view.getViewKey().equals(customAction.viewKey)) {
<a name="409" href="#409">409</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Cannot execute custom action ("</span>+customAction.action+<span class="string">") for request method "</span> + req.getMethod()
<a name="410" href="#410">410</a>                                                 + <span class="string">", The custom action view key ("</span>+customAction.viewKey+<span class="string">") must match the request view key ("</span>+view.getViewKey()+<span class="string">")"</span>, 
<a name="411" href="#411">411</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST );
<a name="412" href="#412">412</a>                                     }
<a name="413" href="#413">413</a>                                     <strong>try</strong> {
<a name="414" href="#414">414</a>                                         actionReturn = entityActionsManager.handleCustomActionRequest(actionProvider, view, customAction.action, req, res, 
<a name="415" href="#415">415</a>                                                 requestStorage.getStorageMapCopy(<strong>true</strong>, false, <strong>true</strong>, <strong>true</strong>) );
<a name="416" href="#416">416</a>                                     } <strong>catch</strong> (SecurityException se) {
<a name="417" href="#417">417</a>                                         <em class="comment">// AJAX/WS type security exceptions are handled specially, no redirect</em>
<a name="418" href="#418">418</a>                                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Security exception handling request for view ("</span>+view+<span class="string">"), "</span>
<a name="419" href="#419">419</a>                                                 + <span class="string">"this is typically caused by the current user not having access to the "</span>
<a name="420" href="#420">420</a>                                                 + <span class="string">"data requested or the user not being logged in at all :: message="</span> + se.getMessage(),
<a name="421" href="#421">421</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_FORBIDDEN);
<a name="422" href="#422">422</a>                                     } <strong>catch</strong> (EntityNotFoundException e) {
<a name="423" href="#423">423</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Cannot execute custom action ("</span>+customAction.action+<span class="string">"): Could not find entity ("</span>+e.entityReference+<span class="string">"): "</span> + e.getMessage(), 
<a name="424" href="#424">424</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_NOT_FOUND );
<a name="425" href="#425">425</a>                                     } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="426" href="#426">426</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Cannot execute custom action ("</span>+customAction.action+<span class="string">"): Format not supported ("</span>+e.format+<span class="string">"): "</span> + e.getMessage(), 
<a name="427" href="#427">427</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_NOT_ACCEPTABLE );
<a name="428" href="#428">428</a>                                     } <strong>catch</strong> (IllegalArgumentException e) {
<a name="429" href="#429">429</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Cannot execute custom action ("</span>+customAction.action+<span class="string">"): Illegal arguments: "</span> + e.getMessage(), 
<a name="430" href="#430">430</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST );
<a name="431" href="#431">431</a>                                     } <strong>catch</strong> (UnsupportedOperationException e) {
<a name="432" href="#432">432</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"Cannot execute custom action ("</span>+customAction.action+<span class="string">"): Could not execute action: "</span> + e.getMessage(), 
<a name="433" href="#433">433</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST );
<a name="434" href="#434">434</a>                                     }
<a name="435" href="#435">435</a>                                     <strong>if</strong> (actionReturn == <strong>null</strong> 
<a name="436" href="#436">436</a>                                             || actionReturn.output != <strong>null</strong>) {
<a name="437" href="#437">437</a>                                         <em class="comment">// custom action processing complete</em>
<a name="438" href="#438">438</a>                                         <em class="comment">/*<em class="comment"> actionReturn.output != null - this means that there is an </em></em>
<a name="439" href="#439">439</a> <em class="comment">                                         * outputstream set and that the encoding has been,</em>
<a name="440" href="#440">440</a> <em class="comment">                                         * handled, however, the response status code should be set still</em>
<a name="441" href="#441">441</a> <em class="comment">                                         */</em>
<a name="442" href="#442">442</a>                                         handled = <strong>true</strong>;
<a name="443" href="#443">443</a>                                     } <strong>else</strong> {
<a name="444" href="#444">444</a>                                         <em class="comment">// if there are headers then set them now</em>
<a name="445" href="#445">445</a>                                         addResponseHeaders(res, actionReturn.getHeaders());
<a name="446" href="#446">446</a>                                         <em class="comment">// if the custom action returned entity data then we will encode it for output</em>
<a name="447" href="#447">447</a>                                         <strong>if</strong> (actionReturn.entitiesList == <strong>null</strong>
<a name="448" href="#448">448</a>                                                 &amp;&amp; actionReturn.entityData == <strong>null</strong>) {
<a name="449" href="#449">449</a>                                             handled = <strong>true</strong>;
<a name="450" href="#450">450</a>                                         } <strong>else</strong> {
<a name="451" href="#451">451</a>                                             <em class="comment">// there is entity data to return</em>
<a name="452" href="#452">452</a>                                             output = <strong>true</strong>;
<a name="453" href="#453">453</a>                                             handled = false;
<a name="454" href="#454">454</a>                                             <em class="comment">// populate the entity data</em>
<a name="455" href="#455">455</a>                                             <strong>if</strong> (actionReturn.entitiesList != <strong>null</strong>) {
<a name="456" href="#456">456</a>                                                 <strong>if</strong> (actionReturn.entitiesList.size() > 1) {
<a name="457" href="#457">457</a>                                                     <em class="comment">// correct the view key which should be used now</em>
<a name="458" href="#458">458</a>                                                     view.setViewKey(EntityView.VIEW_LIST);
<a name="459" href="#459">459</a>                                                 }
<a name="460" href="#460">460</a>                                                 entityBrokerManager.populateEntityData(actionReturn.entitiesList);
<a name="461" href="#461">461</a>                                             } <strong>else</strong> <strong>if</strong> (actionReturn.entityData != <strong>null</strong>) {
<a name="462" href="#462">462</a>                                                 <em class="comment">// correct the view key which should be used now</em>
<a name="463" href="#463">463</a>                                                 view.setViewKey(EntityView.VIEW_SHOW);
<a name="464" href="#464">464</a>                                                 entityBrokerManager.populateEntityData( <strong>new</strong> EntityData[] {actionReturn.entityData} );
<a name="465" href="#465">465</a>                                             }
<a name="466" href="#466">466</a>                                         }
<a name="467" href="#467">467</a>                                     }
<a name="468" href="#468">468</a>                                 }
<a name="469" href="#469">469</a>     
<a name="470" href="#470">470</a>                                 <strong>boolean</strong> formatInvalidFailure = false;
<a name="471" href="#471">471</a>                                 <strong>if</strong> (!handled) {
<a name="472" href="#472">472</a>                                     <em class="comment">// INTERNAL PROCESSING OF REQUEST</em>
<a name="473" href="#473">473</a>                                     <strong>try</strong> {
<a name="474" href="#474">474</a>                                         String format = view.getFormat();
<a name="475" href="#475">475</a>                                         <strong>if</strong> (output) {
<a name="476" href="#476">476</a>                                             <em class="comment">// output request</em>
<a name="477" href="#477">477</a>                                             String viewKey = view.getViewKey();
<a name="478" href="#478">478</a>                                             <strong>if</strong> (EntityView.VIEW_NEW.equals(viewKey)
<a name="479" href="#479">479</a>                                                     || EntityView.VIEW_EDIT.equals(viewKey) 
<a name="480" href="#480">480</a>                                                     || EntityView.VIEW_DELETE.equals(viewKey) ) {
<a name="481" href="#481">481</a>                                                 <em class="comment">// request for the create/edit/delete entity forms</em>
<a name="482" href="#482">482</a>                                                 <em class="comment">// TODO possibly generate new/edit/delete forms internally?</em>
<a name="483" href="#483">483</a>                                                 handled = false;
<a name="484" href="#484">484</a>                                             } <strong>else</strong> {
<a name="485" href="#485">485</a>                                                 Outputable outputable = (Outputable) entityProviderManager.getProviderByPrefixAndCapability(prefix, Outputable.<strong>class</strong>);
<a name="486" href="#486">486</a>                                                 <strong>if</strong> (outputable != <strong>null</strong>) {
<a name="487" href="#487">487</a>                                                     <strong>if</strong> (customAction != <strong>null</strong>) {
<a name="488" href="#488">488</a>                                                         <em class="comment">// override format from the custom action</em>
<a name="489" href="#489">489</a>                                                         <strong>if</strong> (actionReturn != <strong>null</strong> 
<a name="490" href="#490">490</a>                                                                 &amp;&amp; actionReturn.format != <strong>null</strong>) {
<a name="491" href="#491">491</a>                                                             format = actionReturn.format;
<a name="492" href="#492">492</a>                                                         }
<a name="493" href="#493">493</a>                                                     }
<a name="494" href="#494">494</a>                                                     String[] outputFormats = outputable.getHandledOutputFormats();
<a name="495" href="#495">495</a>                                                     <strong>if</strong> (outputFormats == <strong>null</strong> || ReflectUtils.contains(outputFormats, format) ) {
<a name="496" href="#496">496</a>                                                         <em class="comment">// we are handling this type of format for this entity</em>
<a name="497" href="#497">497</a>                                                         RequestUtils.setResponseEncoding(format, res);
<a name="498" href="#498">498</a>     
<a name="499" href="#499">499</a>                                                         EntityReference ref = view.getEntityReference();
<a name="500" href="#500">500</a>                                                         <em class="comment">// get the entities to output</em>
<a name="501" href="#501">501</a>                                                         List&lt;EntityData> entities = <strong>null</strong>;
<a name="502" href="#502">502</a>                                                         <strong>if</strong> (customAction != <strong>null</strong> 
<a name="503" href="#503">503</a>                                                                 &amp;&amp; actionReturn != <strong>null</strong>) {
<a name="504" href="#504">504</a>                                                             <em class="comment">// get entities from a custom action</em>
<a name="505" href="#505">505</a>                                                             entities = actionReturn.entitiesList;
<a name="506" href="#506">506</a>                                                             <strong>if</strong> (entities != <strong>null</strong>) {
<a name="507" href="#507">507</a>                                                                 <em class="comment">// recode the collection</em>
<a name="508" href="#508">508</a>                                                                 <strong>if</strong> (entities.size() > 0) {
<a name="509" href="#509">509</a>                                                                     EntityData ed = entities.get(0);
<a name="510" href="#510">510</a>                                                                     ref = <strong>new</strong> EntityReference(ed.getEntityRef().getPrefix(), <span class="string">""</span>);
<a name="511" href="#511">511</a>                                                                     view.setEntityReference( ref );
<a name="512" href="#512">512</a>                                                                     view.setViewKey(EntityView.VIEW_LIST);
<a name="513" href="#513">513</a>                                                                 }
<a name="514" href="#514">514</a>                                                             } <strong>else</strong> <strong>if</strong> (actionReturn.entityData != <strong>null</strong>) {
<a name="515" href="#515">515</a>                                                                 <em class="comment">// this was a single object return so it should be encoded as such, thus we will recode the correct reference into the view</em>
<a name="516" href="#516">516</a>                                                                 ArrayList&lt;EntityData> eList = <strong>new</strong> ArrayList&lt;EntityData>();
<a name="517" href="#517">517</a>                                                                 EntityData ed = actionReturn.entityData;
<a name="518" href="#518">518</a>                                                                 <em class="comment">// set title if not set</em>
<a name="519" href="#519">519</a>                                                                 <strong>if</strong> (! ed.isDisplayTitleSet()) {
<a name="520" href="#520">520</a>                                                                     ed.setDisplayTitle(customAction.action);
<a name="521" href="#521">521</a>                                                                 }
<a name="522" href="#522">522</a>                                                                 <em class="comment">// add to list</em>
<a name="523" href="#523">523</a>                                                                 eList.add( ed );
<a name="524" href="#524">524</a>                                                                 entities = eList;
<a name="525" href="#525">525</a>                                                                 <em class="comment">// make entity reference</em>
<a name="526" href="#526">526</a>                                                                 ref = ed.getEntityRef();
<a name="527" href="#527">527</a>                                                                 <strong>if</strong> (ref == <strong>null</strong>) {
<a name="528" href="#528">528</a>                                                                     ref = <strong>new</strong> EntityReference(prefix, customAction.action);
<a name="529" href="#529">529</a>                                                                 } <strong>else</strong> <strong>if</strong> (ref.getId() == <strong>null</strong>) {
<a name="530" href="#530">530</a>                                                                     ref = <strong>new</strong> EntityReference(ref.getPrefix(), customAction.action);
<a name="531" href="#531">531</a>                                                                 }
<a name="532" href="#532">532</a>                                                                 view.setEntityReference( ref );
<a name="533" href="#533">533</a>                                                                 view.setViewKey(EntityView.VIEW_SHOW);
<a name="534" href="#534">534</a>                                                             }
<a name="535" href="#535">535</a>                                                         } <strong>else</strong> {
<a name="536" href="#536">536</a>                                                             <em class="comment">// get from a search</em>
<a name="537" href="#537">537</a>                                                             Search search = RequestUtils.makeSearchFromRequestParams(requestStorage.getStorageMapCopy(<strong>true</strong>, false, <strong>true</strong>, <strong>true</strong>)); <em class="comment">// leave out headers));</em>
<a name="538" href="#538">538</a>                                                             entities = entityBrokerManager.getEntitiesData(ref, search, requestStorage.getStorageMapCopy());
<a name="539" href="#539">539</a>                                                         }
<a name="540" href="#540">540</a>                                                         <em class="comment">// set the modified header (use the sole entity in the list if there is one only)</em>
<a name="541" href="#541">541</a>                                                         setLastModifiedHeaders(res, (entities != <strong>null</strong> &amp;&amp; entities.size()==1 ? entities.get(0) : <strong>null</strong>), System.currentTimeMillis());
<a name="542" href="#542">542</a>     
<a name="543" href="#543">543</a>                                                         <strong>if</strong> (EntityView.Method.HEAD.name().equals(view.getMethod())) {
<a name="544" href="#544">544</a>                                                             <em class="comment">// HEADER only</em>
<a name="545" href="#545">545</a>                                                             res.setStatus(HttpServletResponse.SC_NO_CONTENT);
<a name="546" href="#546">546</a>                                                         } <strong>else</strong> {
<a name="547" href="#547">547</a>                                                             <em class="comment">// GET</em>
<a name="548" href="#548">548</a>                                                             OutputStream outputStream = <strong>new</strong> LazyResponseOutputStream(res);
<a name="549" href="#549">549</a>     
<a name="550" href="#550">550</a>                                                             <em class="comment">/*<em class="comment"> try to use the provider formatter if one available,</em></em>
<a name="551" href="#551">551</a> <em class="comment">                                                             * if it decided not to handle it or none is available then control passes to internal</em>
<a name="552" href="#552">552</a> <em class="comment">                                                             */</em>
<a name="553" href="#553">553</a>                                                             <strong>try</strong> {
<a name="554" href="#554">554</a>                                                                 OutputFormattable formattable = (OutputFormattable) entityProviderManager.getProviderByPrefixAndCapability(prefix, OutputFormattable.<strong>class</strong>);
<a name="555" href="#555">555</a>                                                                 <strong>if</strong> (formattable != <strong>null</strong>) {
<a name="556" href="#556">556</a>                                                                     <em class="comment">// use provider's formatter</em>
<a name="557" href="#557">557</a>                                                                     formattable.formatOutput(ref, format, entities, requestStorage.getStorageMapCopy(), outputStream);
<a name="558" href="#558">558</a>                                                                     handled = <strong>true</strong>;
<a name="559" href="#559">559</a>                                                                 }
<a name="560" href="#560">560</a>                                                             } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="561" href="#561">561</a>                                                                 <em class="comment">// provider decided not to handle this format</em>
<a name="562" href="#562">562</a>                                                                 handled = false;
<a name="563" href="#563">563</a>                                                             }
<a name="564" href="#564">564</a>                                                             <strong>if</strong> (!handled) {
<a name="565" href="#565">565</a>                                                                 <em class="comment">// handle internally or fail</em>
<a name="566" href="#566">566</a>                                                                 entityEncodingManager.internalOutputFormatter(ref, format, entities, requestStorage.getStorageMapCopy(), outputStream, view);
<a name="567" href="#567">567</a>                                                             }
<a name="568" href="#568">568</a>                                                             handled = <strong>true</strong>;
<a name="569" href="#569">569</a>                                                             res.setStatus(HttpServletResponse.SC_OK);
<a name="570" href="#570">570</a>                                                         }
<a name="571" href="#571">571</a>                                                     } <strong>else</strong> {
<a name="572" href="#572">572</a>                                                         <em class="comment">// format type not handled</em>
<a name="573" href="#573">573</a>                                                         <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Outputable restriction for "</span> 
<a name="574" href="#574">574</a>                                                                 + prefix + <span class="string">" blocked handling this format ("</span>+format+<span class="string">")"</span>,
<a name="575" href="#575">575</a>                                                                 view.getEntityReference()+<span class="string">""</span>, format);
<a name="576" href="#576">576</a>                                                     }
<a name="577" href="#577">577</a>                                                 }
<a name="578" href="#578">578</a>                                             }
<a name="579" href="#579">579</a>                                         } <strong>else</strong> {
<a name="580" href="#580">580</a>                                             <em class="comment">// input request</em>
<a name="581" href="#581">581</a>                                             <strong>if</strong> (EntityView.VIEW_DELETE.equals(view.getViewKey())) {
<a name="582" href="#582">582</a>                                                 <em class="comment">// delete request</em>
<a name="583" href="#583">583</a>                                                 Deleteable deleteable = (Deleteable) entityProviderManager.getProviderByPrefixAndCapability(prefix, Deleteable.<strong>class</strong>);
<a name="584" href="#584">584</a>                                                 <strong>if</strong> (deleteable != <strong>null</strong>) {
<a name="585" href="#585">585</a>                                                     deleteable.deleteEntity(view.getEntityReference(), requestStorage.getStorageMapCopy());
<a name="586" href="#586">586</a>                                                     res.setStatus(HttpServletResponse.SC_NO_CONTENT);
<a name="587" href="#587">587</a>                                                     handled = <strong>true</strong>;
<a name="588" href="#588">588</a>                                                 }
<a name="589" href="#589">589</a>                                             } <strong>else</strong> {
<a name="590" href="#590">590</a>                                                 <em class="comment">// save request</em>
<a name="591" href="#591">591</a>                                                 Inputable inputable = (Inputable) entityProviderManager.getProviderByPrefixAndCapability(prefix, Inputable.<strong>class</strong>);
<a name="592" href="#592">592</a>                                                 <strong>if</strong> (inputable != <strong>null</strong>) {
<a name="593" href="#593">593</a>                                                     String[] inputFormats = inputable.getHandledInputFormats();
<a name="594" href="#594">594</a>                                                     <strong>if</strong> (inputFormats == <strong>null</strong> || ReflectUtils.contains(inputFormats, format) ) {
<a name="595" href="#595">595</a>                                                         <em class="comment">// we are handling this type of format for this entity</em>
<a name="596" href="#596">596</a>                                                         Object entity = <strong>null</strong>;
<a name="597" href="#597">597</a>                                                         InputStream inputStream = <strong>null</strong>;
<a name="598" href="#598">598</a>                                                         <strong>try</strong> {
<a name="599" href="#599">599</a>                                                             inputStream = req.getInputStream();
<a name="600" href="#600">600</a>                                                         } <strong>catch</strong> (IOException e) {
<a name="601" href="#601">601</a>                                                             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failed to get output stream from response: "</span> + view.getEntityReference(), e);
<a name="602" href="#602">602</a>                                                         }
<a name="603" href="#603">603</a>     
<a name="604" href="#604">604</a>                                                         <em class="comment">/*<em class="comment"> try to use the provider translator if one available,</em></em>
<a name="605" href="#605">605</a> <em class="comment">                                                         * if it decided not to handle it or none is available then control passes to internal</em>
<a name="606" href="#606">606</a> <em class="comment">                                                         */</em>
<a name="607" href="#607">607</a>                                                         <strong>try</strong> {
<a name="608" href="#608">608</a>                                                             InputTranslatable translatable = (InputTranslatable) entityProviderManager.getProviderByPrefixAndCapability(prefix, InputTranslatable.<strong>class</strong>);
<a name="609" href="#609">609</a>                                                             <strong>if</strong> (translatable != <strong>null</strong>) {
<a name="610" href="#610">610</a>                                                                 <em class="comment">// use provider's translator</em>
<a name="611" href="#611">611</a>                                                                 entity = translatable.translateFormattedData(view.getEntityReference(), 
<a name="612" href="#612">612</a>                                                                         format, inputStream, requestStorage.getStorageMapCopy());
<a name="613" href="#613">613</a>                                                                 handled = <strong>true</strong>;
<a name="614" href="#614">614</a>                                                             }
<a name="615" href="#615">615</a>                                                         } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="616" href="#616">616</a>                                                             <em class="comment">// provider decided not to handle this format</em>
<a name="617" href="#617">617</a>                                                             handled = false;
<a name="618" href="#618">618</a>                                                         }
<a name="619" href="#619">619</a>                                                         <strong>if</strong> (!handled) {
<a name="620" href="#620">620</a>                                                             <em class="comment">// use internal translators or fail</em>
<a name="621" href="#621">621</a>                                                             entity = entityEncodingManager.internalInputTranslator(view.getEntityReference(), 
<a name="622" href="#622">622</a>                                                                     format, inputStream, req);
<a name="623" href="#623">623</a>                                                         }
<a name="624" href="#624">624</a>     
<a name="625" href="#625">625</a>                                                         <strong>if</strong> (entity == <strong>null</strong>) {
<a name="626" href="#626">626</a>                                                             <em class="comment">// FAILURE input could not be translated into an entity object</em>
<a name="627" href="#627">627</a>                                                             handled = false;
<a name="628" href="#628">628</a>                                                             <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to save entity ("</span>+view.getEntityReference()+<span class="string">") with format ("</span>
<a name="629" href="#629">629</a>                                                                     +format+<span class="string">"), translated entity object was null"</span>, 
<a name="630" href="#630">630</a>                                                                     view.toString(), HttpServletResponse.SC_BAD_REQUEST);
<a name="631" href="#631">631</a>                                                         } <strong>else</strong> {
<a name="632" href="#632">632</a>                                                             <em class="comment">// setup all the headers for the response</em>
<a name="633" href="#633">633</a>                                                             <strong>if</strong> (EntityView.VIEW_NEW.equals(view.getViewKey())) {
<a name="634" href="#634">634</a>                                                                 Createable createable = entityProviderManager.getProviderByPrefixAndCapability(prefix, Createable.<strong>class</strong>);
<a name="635" href="#635">635</a>                                                                 <strong>if</strong> (createable == <strong>null</strong>) {
<a name="636" href="#636">636</a>                                                                     <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to create new entity ("</span>+view+<span class="string">"), "</span>
<a name="637" href="#637">637</a>                                                                             +Createable.<strong>class</strong>.getName()+<span class="string">" is not implemented for this entity type ("</span>+prefix+<span class="string">")"</span>, 
<a name="638" href="#638">638</a>                                                                             view+<span class="string">""</span>, HttpServletResponse.SC_NOT_IMPLEMENTED);
<a name="639" href="#639">639</a>                                                                 }
<a name="640" href="#640">640</a>                                                                 String createdId = createable.createEntity(view.getEntityReference(), entity, requestStorage.getStorageMapCopy());
<a name="641" href="#641">641</a>                                                                 <strong>if</strong> (createdId == <strong>null</strong> || <span class="string">""</span>.equals(createdId)) {
<a name="642" href="#642">642</a>                                                                     <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Could not get the createdId from the newly created entity for ("</span>+view+<span class="string">"), please ensure the provider is returning a non-null and non-empty value from the create method, if the item was not created then an exception should have been thrown"</span>);
<a name="643" href="#643">643</a>                                                                 }
<a name="644" href="#644">644</a>                                                                 view.setEntityReference( <strong>new</strong> EntityReference(prefix, createdId) ); <em class="comment">// update the entity view</em>
<a name="645" href="#645">645</a>                                                                 res.setHeader(EntityRequestHandler.HEADER_ENTITY_ID, createdId);
<a name="646" href="#646">646</a>                                                                 res.setStatus(HttpServletResponse.SC_CREATED);
<a name="647" href="#647">647</a>                                                                 <em class="comment">// added the id to the response to make it easier on Nico</em>
<a name="648" href="#648">648</a>                                                                 <strong>try</strong> {
<a name="649" href="#649">649</a>                                                                     OutputStream outputStream = res.getOutputStream();
<a name="650" href="#650">650</a>                                                                     outputStream.write( createdId.getBytes() );
<a name="651" href="#651">651</a>                                                                 } <strong>catch</strong> (IOException e) {
<a name="652" href="#652">652</a>                                                                     <em class="comment">// oh well, no id in the output</em>
<a name="653" href="#653">653</a>                                                                 } <strong>catch</strong> (RuntimeException e) {
<a name="654" href="#654">654</a>                                                                     <em class="comment">// oh well, no id in the output</em>
<a name="655" href="#655">655</a>                                                                 }
<a name="656" href="#656">656</a>                                                             } <strong>else</strong> <strong>if</strong> (EntityView.VIEW_EDIT.equals(view.getViewKey())) {
<a name="657" href="#657">657</a>                                                                 Updateable updateable = entityProviderManager.getProviderByPrefixAndCapability(prefix, Updateable.<strong>class</strong>);
<a name="658" href="#658">658</a>                                                                 <strong>if</strong> (updateable == <strong>null</strong>) {
<a name="659" href="#659">659</a>                                                                     <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to create new entity ("</span>+view+<span class="string">"), "</span>
<a name="660" href="#660">660</a>                                                                             +Updateable.<strong>class</strong>.getName()+<span class="string">" is not implemented for this entity type ("</span>+prefix+<span class="string">")"</span>, 
<a name="661" href="#661">661</a>                                                                             view+<span class="string">""</span>, HttpServletResponse.SC_NOT_IMPLEMENTED);
<a name="662" href="#662">662</a>                                                                 }
<a name="663" href="#663">663</a>                                                                 updateable.updateEntity(view.getEntityReference(), entity, requestStorage.getStorageMapCopy());
<a name="664" href="#664">664</a>                                                                 res.setStatus(HttpServletResponse.SC_NO_CONTENT);
<a name="665" href="#665">665</a>                                                             } <strong>else</strong> {
<a name="666" href="#666">666</a>                                                                 <em class="comment">// FAILURE not delete, edit, or new</em>
<a name="667" href="#667">667</a>                                                                 <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to handle entity input ("</span>+view.getEntityReference()+<span class="string">"), "</span> +
<a name="668" href="#668">668</a>                                                                         <span class="string">"action was not understood: "</span> + view.getViewKey(), 
<a name="669" href="#669">669</a>                                                                         view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);
<a name="670" href="#670">670</a>                                                             }
<a name="671" href="#671">671</a>                                                             <em class="comment">// return the location of this updated or created entity (without any extension)</em>
<a name="672" href="#672">672</a>                                                             res.setHeader(EntityRequestHandler.HEADER_ENTITY_URL, view.getEntityURL() );
<a name="673" href="#673">673</a>                                                             res.setHeader(EntityRequestHandler.HEADER_ENTITY_REFERENCE, view.getEntityReference().toString() );
<a name="674" href="#674">674</a>                                                             handled = <strong>true</strong>;
<a name="675" href="#675">675</a>                                                         }
<a name="676" href="#676">676</a>                                                     } <strong>else</strong> {
<a name="677" href="#677">677</a>                                                         <em class="comment">// format type not handled</em>
<a name="678" href="#678">678</a>                                                         <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Inputable restriction for "</span> 
<a name="679" href="#679">679</a>                                                                 + prefix + <span class="string">" blocked handling this format ("</span>+format+<span class="string">")"</span>,
<a name="680" href="#680">680</a>                                                                 view.getEntityReference()+<span class="string">""</span>, format);
<a name="681" href="#681">681</a>                                                     }
<a name="682" href="#682">682</a>                                                 }
<a name="683" href="#683">683</a>                                             }
<a name="684" href="#684">684</a>                                         }
<a name="685" href="#685">685</a>                                     } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="686" href="#686">686</a>                                         <em class="comment">// this format could not be handled internally so we will pass it to the access provider, nothing else to do here</em>
<a name="687" href="#687">687</a>                                         formatInvalidFailure = <strong>true</strong>;
<a name="688" href="#688">688</a>                                         handled = false;
<a name="689" href="#689">689</a>                                     } <strong>catch</strong> (SecurityException se) {
<a name="690" href="#690">690</a>                                         <em class="comment">// AJAX/WS type security exceptions are handled specially, no redirect</em>
<a name="691" href="#691">691</a>                                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Security exception handling request for view ("</span>+view+<span class="string">"), "</span>
<a name="692" href="#692">692</a>                                                 + <span class="string">"this is typically caused by the current user not having access to the "</span>
<a name="693" href="#693">693</a>                                                 + <span class="string">"data requested or the user not being logged in at all :: message="</span> + se.getMessage(),
<a name="694" href="#694">694</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_FORBIDDEN);
<a name="695" href="#695">695</a>                                     } <strong>catch</strong> (EntityEncodingException e) {
<a name="696" href="#696">696</a>                                         <em class="comment">// translate EEE into EE - internal server error</em>
<a name="697" href="#697">697</a>                                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"EntityEncodingException: Unable to handle "</span> + (output ? <span class="string">"output"</span> : <span class="string">"input"</span>) + <span class="string">" request for format  "</span>+view.getFormat()+<span class="string">" for this path ("</span> 
<a name="698" href="#698">698</a>                                                 + path + <span class="string">") for prefix ("</span> + prefix + <span class="string">") for entity ("</span> + view.getEntityReference() + <span class="string">"), request url ("</span> + view.getOriginalEntityUrl() + <span class="string">"): "</span> + e.getMessage(),
<a name="699" href="#699">699</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_INTERNAL_SERVER_ERROR);        
<a name="700" href="#700">700</a>                                     } <strong>catch</strong> (IllegalArgumentException e) {
<a name="701" href="#701">701</a>                                         <em class="comment">// translate IAE into EE - bad request</em>
<a name="702" href="#702">702</a>                                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"IllegalArgumentException: Unable to handle "</span> + (output ? <span class="string">"output"</span> : <span class="string">"input"</span>) + <span class="string">" request for format  "</span>+view.getFormat()+<span class="string">" for this path ("</span> 
<a name="703" href="#703">703</a>                                                 + path + <span class="string">") for prefix ("</span> + prefix + <span class="string">") for entity ("</span> + view.getEntityReference() + <span class="string">"), request url ("</span> + view.getOriginalEntityUrl() + <span class="string">"): "</span> + e.getMessage(),
<a name="704" href="#704">704</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);        
<a name="705" href="#705">705</a>                                     } <strong>catch</strong> (IllegalStateException e) {
<a name="706" href="#706">706</a>                                         <em class="comment">// translate ISE into EE - internal server error</em>
<a name="707" href="#707">707</a>                                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"IllegalStateException: Unable to handle "</span> + (output ? <span class="string">"output"</span> : <span class="string">"input"</span>) + <span class="string">" request for format  "</span>+view.getFormat()+<span class="string">" for this path ("</span> 
<a name="708" href="#708">708</a>                                                 + path + <span class="string">") for prefix ("</span> + prefix + <span class="string">") for entity ("</span> + view.getEntityReference() + <span class="string">"), request url ("</span> + view.getOriginalEntityUrl() + <span class="string">"): "</span> + e.getMessage(),
<a name="709" href="#709">709</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
<a name="710" href="#710">710</a>                                     }
<a name="711" href="#711">711</a>                                 }
<a name="712" href="#712">712</a>     
<a name="713" href="#713">713</a>                                 <strong>if</strong> (! handled) {
<a name="714" href="#714">714</a>                                     <em class="comment">// default handling, send to the access provider if there is one (if none this will throw EntityException)</em>
<a name="715" href="#715">715</a>                                     <strong>try</strong> {
<a name="716" href="#716">716</a>                                         <strong>boolean</strong> accessProviderExists = handleAccessProvider(view, req, res);
<a name="717" href="#717">717</a>                                         <strong>if</strong> (!accessProviderExists) {
<a name="718" href="#718">718</a>                                             <strong>if</strong> (formatInvalidFailure) {
<a name="719" href="#719">719</a>                                                 <em class="comment">// trigger the format </em>
<a name="720" href="#720">720</a>                                                 <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Nothing (AP and internal) available to handle the requested format"</span>, view.getEntityReference()+<span class="string">""</span>, view.getFormat());
<a name="721" href="#721">721</a>                                             }
<a name="722" href="#722">722</a>                                             String message = <span class="string">"Access Provider: Attempted to access an entity URL path ("</span>
<a name="723" href="#723">723</a>                                                 + view + <span class="string">") using method ("</span>+view.getMethod()+<span class="string">") for an entity ("</span> + view.getEntityReference() 
<a name="724" href="#724">724</a>                                                 + <span class="string">") and view ("</span>+view.getViewKey()+<span class="string">") when there is no "</span> 
<a name="725" href="#725">725</a>                                                 + <span class="string">"access provider to handle the request for prefix ("</span> + view.getEntityReference().getPrefix() + <span class="string">")"</span>;
<a name="726" href="#726">726</a>                                             <strong>throw</strong> <strong>new</strong> EntityException( message, view.toString(), HttpServletResponse.SC_METHOD_NOT_ALLOWED );
<a name="727" href="#727">727</a>                                         }
<a name="728" href="#728">728</a>                                     } <strong>catch</strong> (FormatUnsupportedException e) {
<a name="729" href="#729">729</a>                                         <em class="comment">// TODO add in the methods "allowed" header?</em>
<a name="730" href="#730">730</a>                                         <strong>throw</strong> <strong>new</strong> EntityException( <span class="string">"AccessProvider: Method/Format unsupported: Will not handle "</span> + (output ? <span class="string">"output"</span> : <span class="string">"input"</span>) + <span class="string">" request for format  "</span>+view.getFormat()+<span class="string">" for this path ("</span> 
<a name="731" href="#731">731</a>                                                 + path + <span class="string">") for prefix ("</span> + prefix + <span class="string">") for entity ("</span> + view.getEntityReference() + <span class="string">"), request url ("</span> + view.getOriginalEntityUrl() + <span class="string">")"</span>,
<a name="732" href="#732">732</a>                                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST );
<a name="733" href="#733">733</a>                                     }
<a name="734" href="#734">734</a>                                 }
<a name="735" href="#735">735</a>                             }
<a name="736" href="#736">736</a>                         }
<a name="737" href="#737">737</a>                         handledReference = view.getEntityReference().toString();
<a name="738" href="#738">738</a>                         requestStorage.setRequestValue(RequestStorage.ReservedKeys._requestEntityReference.name(), handledReference);
<a name="739" href="#739">739</a> 
<a name="740" href="#740">740</a>                         <em class="comment">// handle the after interceptor</em>
<a name="741" href="#741">741</a>                         <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="742" href="#742">742</a>                             interceptor.after(view, req, res);
<a name="743" href="#743">743</a>                         }
<a name="744" href="#744">744</a>                     } <strong>finally</strong> {
<a name="745" href="#745">745</a>                         <em class="comment">// clear the request data no matter what happens</em>
<a name="746" href="#746">746</a>                         requestStorage.reset();
<a name="747" href="#747">747</a>                         requestGetter.setRequest(<strong>null</strong>);
<a name="748" href="#748">748</a>                         requestGetter.setResponse(<strong>null</strong>);
<a name="749" href="#749">749</a>                     }
<a name="750" href="#750">750</a>                 }
<a name="751" href="#751">751</a>             }
<a name="752" href="#752">752</a>         }
<a name="753" href="#753">753</a>         <strong>return</strong> handledReference;
<a name="754" href="#754">754</a>     }
<a name="755" href="#755">755</a> 
<a name="756" href="#756">756</a> 
<a name="757" href="#757">757</a>     <em>/**<em>*</em></em>
<a name="758" href="#758">758</a> <em>     * @see EntityBroker#fireEntityRequest(String, String, String, Map, Object)</em>
<a name="759" href="#759">759</a> <em>     */</em>
<a name="760" href="#760">760</a>     <strong>public</strong> EntityResponse fireEntityRequestInternal(String reference, String viewKey, String format, Map&lt;String, String> params, Object entity) {
<a name="761" href="#761">761</a>         <strong>if</strong> (reference == <strong>null</strong>) {
<a name="762" href="#762">762</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"reference must not be null"</span>);
<a name="763" href="#763">763</a>         }
<a name="764" href="#764">764</a>         <em class="comment">// convert the reference/key/format into a URL</em>
<a name="765" href="#765">765</a>         EntityReference ref = <strong>new</strong> EntityReference(reference);
<a name="766" href="#766">766</a>         EntityView ev = <strong>new</strong> EntityView();
<a name="767" href="#767">767</a>         ev.setEntityReference( ref );
<a name="768" href="#768">768</a>         <strong>if</strong> (viewKey != <strong>null</strong> 
<a name="769" href="#769">769</a>                 &amp;&amp; ! <span class="string">""</span>.equals(viewKey)) {
<a name="770" href="#770">770</a>             ev.setViewKey(viewKey);
<a name="771" href="#771">771</a>         }
<a name="772" href="#772">772</a>         <strong>if</strong> (format != <strong>null</strong> 
<a name="773" href="#773">773</a>                 &amp;&amp; ! <span class="string">""</span>.equals(format)) {
<a name="774" href="#774">774</a>             ev.setExtension(format);
<a name="775" href="#775">775</a>         }
<a name="776" href="#776">776</a>         String URL = ev.toString();
<a name="777" href="#777">777</a>         <em class="comment">// get the right method to use</em>
<a name="778" href="#778">778</a>         Method method = Method.GET;
<a name="779" href="#779">779</a>         <strong>if</strong> (EntityView.VIEW_DELETE.equals(ev.getViewKey())) {
<a name="780" href="#780">780</a>             method = Method.DELETE;
<a name="781" href="#781">781</a>         } <strong>else</strong> <strong>if</strong> (EntityView.VIEW_EDIT.equals(ev.getViewKey())) {
<a name="782" href="#782">782</a>             method = Method.PUT;
<a name="783" href="#783">783</a>         } <strong>else</strong> <strong>if</strong> (EntityView.VIEW_NEW.equals(ev.getViewKey())) {
<a name="784" href="#784">784</a>             method = Method.POST;
<a name="785" href="#785">785</a>         } <strong>else</strong> {
<a name="786" href="#786">786</a>             method = Method.GET;
<a name="787" href="#787">787</a>         }
<a name="788" href="#788">788</a>         <em class="comment">// handle entity if one was included</em>
<a name="789" href="#789">789</a>         Object data = <strong>null</strong>;
<a name="790" href="#790">790</a>         <strong>if</strong> (entity != <strong>null</strong>) {
<a name="791" href="#791">791</a>             String prefix = ref.getPrefix();
<a name="792" href="#792">792</a>             Inputable inputable = entityProviderManager.getProviderByPrefixAndCapability(prefix, Inputable.<strong>class</strong>);
<a name="793" href="#793">793</a>             <strong>if</strong> (inputable == <strong>null</strong>) {
<a name="794" href="#794">794</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"This entity ("</span>+ref+<span class="string">") is not Inputable so there is no reason to provide "</span>
<a name="795" href="#795">795</a>                         + <span class="string">"a non-null entity, you should leave the entity null when firing requests to this entity"</span>);
<a name="796" href="#796">796</a>             }
<a name="797" href="#797">797</a>             Outputable outputable = entityProviderManager.getProviderByPrefixAndCapability(prefix, Outputable.<strong>class</strong>);
<a name="798" href="#798">798</a>             <strong>if</strong> (outputable == <strong>null</strong>) {
<a name="799" href="#799">799</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"This entity ("</span>+ref+<span class="string">") is not AccessFormats so there is no reason to provide "</span>
<a name="800" href="#800">800</a>                         + <span class="string">"a non-null entity, you should leave the entity null when firing requests to this entity"</span>);
<a name="801" href="#801">801</a>             } <strong>else</strong> {
<a name="802" href="#802">802</a>                 <em class="comment">// handle outputing the entity data</em>
<a name="803" href="#803">803</a>                 List&lt;EntityData> entities = <strong>new</strong> ArrayList&lt;EntityData>();
<a name="804" href="#804">804</a>                 entities.add( EntityDataUtils.makeEntityData(ref, entity) );
<a name="805" href="#805">805</a>                 ByteArrayOutputStream output = <strong>new</strong> ByteArrayOutputStream();
<a name="806" href="#806">806</a>                 entityEncodingManager.formatAndOutputEntity(ref, format, entities, output, <strong>null</strong>);
<a name="807" href="#807">807</a>                 data = <strong>new</strong> ByteArrayInputStream(output.toByteArray());
<a name="808" href="#808">808</a>             }
<a name="809" href="#809">809</a>         }
<a name="810" href="#810">810</a>         HttpResponse httpResponse = HttpRESTUtils.fireRequest(URL, method, params, data, <strong>true</strong>);
<a name="811" href="#811">811</a>         <em class="comment">// translate response to correct kind</em>
<a name="812" href="#812">812</a>         EntityResponse response = <strong>new</strong> EntityResponse(httpResponse.getResponseCode(), 
<a name="813" href="#813">813</a>                 httpResponse.getResponseMessage(), httpResponse.getResponseBody(), httpResponse.getResponseHeaders());
<a name="814" href="#814">814</a>         <strong>return</strong> response;
<a name="815" href="#815">815</a>     }
<a name="816" href="#816">816</a> 
<a name="817" href="#817">817</a> 
<a name="818" href="#818">818</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="819" href="#819">819</a> <em class="comment">     * @see org.sakaiproject.entitybus.EntityRequestHandler#handleEntityError(javax.servlet.http.HttpServletRequest, java.lang.Throwable)</em>
<a name="820" href="#820">820</a> <em class="comment">     */</em>
<a name="821" href="#821">821</a>     <strong>public</strong> String handleEntityError(HttpServletRequest req, Throwable error) {
<a name="822" href="#822">822</a>         String msg = <span class="string">"Failure processing entity request ("</span>+req.getPathInfo()+<span class="string">"): "</span> + error.getMessage();
<a name="823" href="#823">823</a>         <strong>if</strong> (entityBrokerManager.getExternalIntegrationProvider() != <strong>null</strong>) {
<a name="824" href="#824">824</a>             <strong>try</strong> {
<a name="825" href="#825">825</a>                 msg = entityBrokerManager.getExternalIntegrationProvider().handleEntityError(req, error);
<a name="826" href="#826">826</a>             } <strong>catch</strong> (UnsupportedOperationException e) {
<a name="827" href="#827">827</a>                 <em class="comment">// nothing to do here, this is OK</em>
<a name="828" href="#828">828</a>             } <strong>catch</strong> (Exception e) {
<a name="829" href="#829">829</a>                 log.warn(<span class="string">"External handleEntityError method failed, using default instead: "</span> + e);
<a name="830" href="#830">830</a>             }
<a name="831" href="#831">831</a>         }
<a name="832" href="#832">832</a>         <strong>return</strong> msg;
<a name="833" href="#833">833</a>     }
<a name="834" href="#834">834</a> 
<a name="835" href="#835">835</a> 
<a name="836" href="#836">836</a>     <em>/**<em>*</em></em>
<a name="837" href="#837">837</a> <em>     * Will choose whichever access provider is currently available to handle the request</em>
<a name="838" href="#838">838</a> <em>     * @return true if there is an access provider, false otherwise</em>
<a name="839" href="#839">839</a> <em>     */</em>
<a name="840" href="#840">840</a>     <strong>private</strong> <strong>boolean</strong> handleAccessProvider(EntityView view, HttpServletRequest req, HttpServletResponse res) {
<a name="841" href="#841">841</a>         <em class="comment">// no special handling so send on to the standard access provider if one can be found</em>
<a name="842" href="#842">842</a>         EntityViewAccessProvider evAccessProvider = entityViewAccessProviderManager.getProvider(view.getEntityReference().getPrefix());
<a name="843" href="#843">843</a>         <strong>if</strong> (evAccessProvider == <strong>null</strong>) {
<a name="844" href="#844">844</a>             <strong>if</strong> (accessProviderManager != <strong>null</strong>) {
<a name="845" href="#845">845</a>                 <em class="comment">// try the old type access provider then</em>
<a name="846" href="#846">846</a>                 HttpServletAccessProvider httpAccessProvider = accessProviderManager.getProvider(view.getEntityReference().getPrefix());
<a name="847" href="#847">847</a>                 <strong>if</strong> (httpAccessProvider == <strong>null</strong>) {
<a name="848" href="#848">848</a>                     <strong>return</strong> false;
<a name="849" href="#849">849</a>                 } <strong>else</strong> {
<a name="850" href="#850">850</a>                     <em class="comment">// classloader protection START</em>
<a name="851" href="#851">851</a>                     ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
<a name="852" href="#852">852</a>                     <strong>try</strong> {
<a name="853" href="#853">853</a>                         Object thing = httpAccessProvider;
<a name="854" href="#854">854</a>                         ClassLoader newClassLoader = thing.getClass().getClassLoader();
<a name="855" href="#855">855</a>                         <em class="comment">// check to see if this access provider reports the correct classloader</em>
<a name="856" href="#856">856</a>                         <strong>if</strong> (thing instanceof ClassLoaderReporter) {
<a name="857" href="#857">857</a>                             newClassLoader = ((ClassLoaderReporter) thing).getSuitableClassLoader();
<a name="858" href="#858">858</a>                         }
<a name="859" href="#859">859</a>                         Thread.currentThread().setContextClassLoader(newClassLoader);
<a name="860" href="#860">860</a>                         <em class="comment">// send request to the access provider which will route it on to the correct entity world</em>
<a name="861" href="#861">861</a>                         httpAccessProvider.handleAccess(req, res, view.getEntityReference());
<a name="862" href="#862">862</a>                     } <strong>finally</strong> {
<a name="863" href="#863">863</a>                         Thread.currentThread().setContextClassLoader(currentClassLoader);
<a name="864" href="#864">864</a>                     }
<a name="865" href="#865">865</a>                     <em class="comment">// classloader protection END</em>
<a name="866" href="#866">866</a>                 }
<a name="867" href="#867">867</a>             }
<a name="868" href="#868">868</a>         } <strong>else</strong> {
<a name="869" href="#869">869</a>             <em class="comment">// check if this view key is specifically disallowed</em>
<a name="870" href="#870">870</a>             <strong>if</strong> (AccessViews.<strong>class</strong>.isAssignableFrom(evAccessProvider.getClass())) {
<a name="871" href="#871">871</a>                 String[] entityViewKeys = ((AccessViews)evAccessProvider).getHandledEntityViews();
<a name="872" href="#872">872</a>                 <strong>if</strong> (entityViewKeys != <strong>null</strong> &amp;&amp; ! ReflectUtils.contains(entityViewKeys, view.getViewKey()) ) {
<a name="873" href="#873">873</a>                     <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Access provider for "</span> + view.getEntityReference().getPrefix() 
<a name="874" href="#874">874</a>                             + <span class="string">" will not handle this view ("</span>+view.getViewKey()+<span class="string">"): "</span> + view,
<a name="875" href="#875">875</a>                             view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);
<a name="876" href="#876">876</a>                 }
<a name="877" href="#877">877</a>             }
<a name="878" href="#878">878</a>             <em class="comment">// check if this format is specifically disallowed</em>
<a name="879" href="#879">879</a>             <strong>if</strong> (AccessFormats.<strong>class</strong>.isAssignableFrom(evAccessProvider.getClass())) {
<a name="880" href="#880">880</a>                 String[] accessFormats = ((AccessFormats)evAccessProvider).getHandledAccessFormats();
<a name="881" href="#881">881</a>                 <strong>if</strong> (accessFormats != <strong>null</strong> &amp;&amp; ! ReflectUtils.contains(accessFormats, view.getFormat()) ) {
<a name="882" href="#882">882</a>                     <strong>throw</strong> <strong>new</strong> FormatUnsupportedException(<span class="string">"Access provider for "</span> + view.getEntityReference().getPrefix() 
<a name="883" href="#883">883</a>                             + <span class="string">" will not handle this format ("</span>+view.getFormat()+<span class="string">")"</span>,
<a name="884" href="#884">884</a>                             view.getEntityReference()+<span class="string">""</span>, view.getFormat());
<a name="885" href="#885">885</a>                 }
<a name="886" href="#886">886</a>             }
<a name="887" href="#887">887</a>             handleClassLoaderAccess(evAccessProvider, req, res, view);
<a name="888" href="#888">888</a>         }
<a name="889" href="#889">889</a>         <strong>return</strong> <strong>true</strong>;
<a name="890" href="#890">890</a>     }
<a name="891" href="#891">891</a> 
<a name="892" href="#892">892</a>     <em>/**<em>*</em></em>
<a name="893" href="#893">893</a> <em>     * Wrap this in an appropriate classloader before handling the request to ensure we</em>
<a name="894" href="#894">894</a> <em>     * do not get ugly classloader failures</em>
<a name="895" href="#895">895</a> <em>     */</em>
<a name="896" href="#896">896</a>     <strong>private</strong> <strong>void</strong> handleClassLoaderAccess(EntityViewAccessProvider accessProvider,
<a name="897" href="#897">897</a>             HttpServletRequest req, HttpServletResponse res, EntityView view) {
<a name="898" href="#898">898</a>         <em class="comment">// START classloader protection</em>
<a name="899" href="#899">899</a>         ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
<a name="900" href="#900">900</a>         <strong>try</strong> {
<a name="901" href="#901">901</a>             Object classloaderIndicator = accessProvider;
<a name="902" href="#902">902</a>             ClassLoader newClassLoader = classloaderIndicator.getClass().getClassLoader();
<a name="903" href="#903">903</a>             <em class="comment">// check to see if this access provider reports the correct classloader</em>
<a name="904" href="#904">904</a>             <strong>if</strong> (classloaderIndicator instanceof ClassLoaderReporter) {
<a name="905" href="#905">905</a>                 newClassLoader = ((ClassLoaderReporter) classloaderIndicator).getSuitableClassLoader();
<a name="906" href="#906">906</a>             }
<a name="907" href="#907">907</a>             Thread.currentThread().setContextClassLoader(newClassLoader);
<a name="908" href="#908">908</a>             <em class="comment">// START run in classloader</em>
<a name="909" href="#909">909</a>             accessProvider.handleAccess(view, req, res);
<a name="910" href="#910">910</a>             <em class="comment">// END run in classloader</em>
<a name="911" href="#911">911</a>         } <strong>finally</strong> {
<a name="912" href="#912">912</a>             Thread.currentThread().setContextClassLoader(currentClassLoader);
<a name="913" href="#913">913</a>         }
<a name="914" href="#914">914</a>         <em class="comment">// END classloader protection</em>
<a name="915" href="#915">915</a>     }
<a name="916" href="#916">916</a> 
<a name="917" href="#917">917</a>     <em>/**<em>*</em></em>
<a name="918" href="#918">918</a> <em>     * Correctly sets up the basic headers for every response</em>
<a name="919" href="#919">919</a> <em>     * @param view</em>
<a name="920" href="#920">920</a> <em>     * @param res</em>
<a name="921" href="#921">921</a> <em>     * @param params</em>
<a name="922" href="#922">922</a> <em>     * @param headers any headers to add on</em>
<a name="923" href="#923">923</a> <em>     */</em>
<a name="924" href="#924">924</a>     <strong>protected</strong> <strong>void</strong> setResponseHeaders(EntityView view, HttpServletResponse res, Map&lt;String, Object> params, Map&lt;String, String> headers) {
<a name="925" href="#925">925</a>         <strong>boolean</strong> noCache = false;
<a name="926" href="#926">926</a>         <strong>long</strong> currentTime = System.currentTimeMillis();
<a name="927" href="#927">927</a>         <strong>long</strong> lastModified = currentTime;
<a name="928" href="#928">928</a>         <strong>if</strong> (params != <strong>null</strong>) {
<a name="929" href="#929">929</a>             String key = <span class="string">"no-cache"</span>;
<a name="930" href="#930">930</a>             <strong>if</strong> (params.containsKey(key)) {
<a name="931" href="#931">931</a>                 <strong>try</strong> {
<a name="932" href="#932">932</a>                     noCache = ((Boolean) params.get(key)).booleanValue();
<a name="933" href="#933">933</a>                 } <strong>catch</strong> (Exception e) {
<a name="934" href="#934">934</a>                     <em class="comment">// in case the value is not there or null</em>
<a name="935" href="#935">935</a>                     noCache = false;
<a name="936" href="#936">936</a>                 }
<a name="937" href="#937">937</a>             }
<a name="938" href="#938">938</a>             key = <span class="string">"last-modified"</span>;
<a name="939" href="#939">939</a>             <strong>if</strong> (params.containsKey(key)) {
<a name="940" href="#940">940</a>                 <strong>try</strong> {
<a name="941" href="#941">941</a>                     lastModified = ((Long) params.get(key)).longValue();
<a name="942" href="#942">942</a>                 } <strong>catch</strong> (Exception e) {
<a name="943" href="#943">943</a>                     <em class="comment">// nothing to do here but use the default time</em>
<a name="944" href="#944">944</a>                     lastModified = currentTime;
<a name="945" href="#945">945</a>                 }
<a name="946" href="#946">946</a>             }
<a name="947" href="#947">947</a>         }
<a name="948" href="#948">948</a>         setLastModifiedHeaders(res, <strong>null</strong>, lastModified);
<a name="949" href="#949">949</a> 
<a name="950" href="#950">950</a>         <em class="comment">// set the cache headers</em>
<a name="951" href="#951">951</a>         
<a name="952" href="#952">952</a>         <strong>if</strong> (noCache) {
<a name="953" href="#953">953</a>             res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"must-revalidate"</span>);
<a name="954" href="#954">954</a>             res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"private"</span>);
<a name="955" href="#955">955</a>             res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"no-store"</span>);
<a name="956" href="#956">956</a>         } <strong>else</strong> {
<a name="957" href="#957">957</a>             <em class="comment">// response.addHeader("Cache-Control", "must-revalidate");</em>
<a name="958" href="#958">958</a>             res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"public"</span>);
<a name="959" href="#959">959</a>         }
<a name="960" href="#960">960</a>         res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"max-age=600"</span>);
<a name="961" href="#961">961</a>         res.addHeader(ActionReturn.Header.CACHE_CONTROL.toString(), <span class="string">"s-maxage=600"</span>);
<a name="962" href="#962">962</a> 
<a name="963" href="#963">963</a>         res.setDateHeader(ActionReturn.Header.DATE.toString(), currentTime);
<a name="964" href="#964">964</a>         res.setDateHeader(ActionReturn.Header.EXPIRES.toString(), currentTime + 600000);
<a name="965" href="#965">965</a> 
<a name="966" href="#966">966</a>         <em class="comment">// set the EB specific headers</em>
<a name="967" href="#967">967</a>         String prefix = view.getEntityReference().getPrefix();
<a name="968" href="#968">968</a>         EntityProvider provider = entityProviderManager.getProviderByPrefix(prefix);
<a name="969" href="#969">969</a>         res.setHeader(<span class="string">"x-entity-prefix"</span>, prefix);
<a name="970" href="#970">970</a>         res.setHeader(<span class="string">"x-entity-reference"</span>, view.getEntityReference().toString());
<a name="971" href="#971">971</a>         res.setHeader(<span class="string">"x-entity-url"</span>, view.getEntityURL());
<a name="972" href="#972">972</a>         res.setHeader(<span class="string">"x-entity-format"</span>, view.getFormat());
<a name="973" href="#973">973</a> 
<a name="974" href="#974">974</a>         <em class="comment">// set Sakai sdata compliant headers</em>
<a name="975" href="#975">975</a>         res.setHeader(<span class="string">"x-sdata-handler"</span>, provider == <strong>null</strong> ? EntityBroker.<strong>class</strong>.getName() : provider.getClass().getName());
<a name="976" href="#976">976</a>         res.setHeader(<span class="string">"x-sdata-url"</span>, view.getOriginalEntityUrl());
<a name="977" href="#977">977</a> 
<a name="978" href="#978">978</a>         <em class="comment">// add in any extra headers last</em>
<a name="979" href="#979">979</a>         addResponseHeaders(res, headers);
<a name="980" href="#980">980</a>     }
<a name="981" href="#981">981</a> 
<a name="982" href="#982">982</a>     <em>/**<em>*</em></em>
<a name="983" href="#983">983</a> <em>     * Adds in headers to the response as needed</em>
<a name="984" href="#984">984</a> <em>     * @param res</em>
<a name="985" href="#985">985</a> <em>     * @param headers</em>
<a name="986" href="#986">986</a> <em>     */</em>
<a name="987" href="#987">987</a>     <strong>protected</strong> <strong>void</strong> addResponseHeaders(HttpServletResponse res, Map&lt;String, String> headers) {
<a name="988" href="#988">988</a>         <em class="comment">// add in any extra headers last</em>
<a name="989" href="#989">989</a>         <strong>if</strong> (headers != <strong>null</strong> &amp;&amp; ! headers.isEmpty()) {
<a name="990" href="#990">990</a>             <strong>for</strong> (Entry&lt;String, String> entry : headers.entrySet()) {
<a name="991" href="#991">991</a>                 res.addHeader(entry.getKey(), entry.getValue());
<a name="992" href="#992">992</a>             }
<a name="993" href="#993">993</a>         }
<a name="994" href="#994">994</a>     }
<a name="995" href="#995">995</a> 
<a name="996" href="#996">996</a>     <em>/**<em>*</em></em>
<a name="997" href="#997">997</a> <em>     * @param res the response</em>
<a name="998" href="#998">998</a> <em>     * @param lastModifiedTime the time to use if none is found any other way</em>
<a name="999" href="#999">999</a> <em>     * @param ed (optional) some entity data if available</em>
<a name="1000" href="#1000">1000</a> <em>     */</em>
<a name="1001" href="#1001">1001</a>     <strong>protected</strong> <strong>void</strong> setLastModifiedHeaders(HttpServletResponse res, EntityData ed, <strong>long</strong> lastModifiedTime) {
<a name="1002" href="#1002">1002</a>         <strong>long</strong> lastModified = System.currentTimeMillis();
<a name="1003" href="#1003">1003</a>         <strong>if</strong> (ed != <strong>null</strong>) {
<a name="1004" href="#1004">1004</a>             <em class="comment">// try to get from props first</em>
<a name="1005" href="#1005">1005</a>             <strong>boolean</strong> found = false;
<a name="1006" href="#1006">1006</a>             Object lm = ed.getEntityProperties().get(<span class="string">"lastModified"</span>);
<a name="1007" href="#1007">1007</a>             <strong>if</strong> (lm != <strong>null</strong>) {
<a name="1008" href="#1008">1008</a>                 Long l = makeLastModified(lm);
<a name="1009" href="#1009">1009</a>                 <strong>if</strong> (l != <strong>null</strong>) {
<a name="1010" href="#1010">1010</a>                     lastModified = l.longValue();
<a name="1011" href="#1011">1011</a>                     found = <strong>true</strong>;
<a name="1012" href="#1012">1012</a>                 }
<a name="1013" href="#1013">1013</a>             }
<a name="1014" href="#1014">1014</a>             <strong>if</strong> (!found) {
<a name="1015" href="#1015">1015</a>                 <strong>if</strong> (ed.getData() != <strong>null</strong>) {
<a name="1016" href="#1016">1016</a>                     <em class="comment">// look for the annotation on the entity</em>
<a name="1017" href="#1017">1017</a>                     <strong>try</strong> {
<a name="1018" href="#1018">1018</a>                         lm = ReflectUtils.getInstance().getFieldValue(ed.getData(), <span class="string">"lastModified"</span>, EntityLastModified.<strong>class</strong>);
<a name="1019" href="#1019">1019</a>                         Long l = makeLastModified(lm);
<a name="1020" href="#1020">1020</a>                         <strong>if</strong> (l != <strong>null</strong>) {
<a name="1021" href="#1021">1021</a>                             lastModified = l.longValue();
<a name="1022" href="#1022">1022</a>                             found = <strong>true</strong>;
<a name="1023" href="#1023">1023</a>                         }
<a name="1024" href="#1024">1024</a>                     } <strong>catch</strong> (FieldnameNotFoundException e1) {
<a name="1025" href="#1025">1025</a>                         <em class="comment">// nothing to do here</em>
<a name="1026" href="#1026">1026</a>                     }
<a name="1027" href="#1027">1027</a>                 }
<a name="1028" href="#1028">1028</a>             }
<a name="1029" href="#1029">1029</a>         } <strong>else</strong> {
<a name="1030" href="#1030">1030</a>             lastModified = lastModifiedTime;
<a name="1031" href="#1031">1031</a>         }
<a name="1032" href="#1032">1032</a>         <em class="comment">// ETag or Last-Modified</em>
<a name="1033" href="#1033">1033</a>         res.setDateHeader(ActionReturn.Header.LAST_MODIFIED.toString(), lastModified);
<a name="1034" href="#1034">1034</a>         String currentEtag = String.valueOf(lastModified);
<a name="1035" href="#1035">1035</a>         res.setHeader(ActionReturn.Header.ETAG.toString(), currentEtag);
<a name="1036" href="#1036">1036</a>     }
<a name="1037" href="#1037">1037</a> 
<a name="1038" href="#1038">1038</a>     <em>/**<em>*</em></em>
<a name="1039" href="#1039">1039</a> <em>     * Make a last modified long from this object if possible OR return null</em>
<a name="1040" href="#1040">1040</a> <em>     * @param lm any object that might be the last modified date</em>
<a name="1041" href="#1041">1041</a> <em>     * @return the long OR null if it cannot be converted</em>
<a name="1042" href="#1042">1042</a> <em>     */</em>
<a name="1043" href="#1043">1043</a>     <strong>private</strong> Long makeLastModified(Object lm) {
<a name="1044" href="#1044">1044</a>         Long lastModified = <strong>null</strong>;
<a name="1045" href="#1045">1045</a>         <strong>if</strong> (lm != <strong>null</strong>) {
<a name="1046" href="#1046">1046</a>             Class&lt;?> c = lm.getClass();
<a name="1047" href="#1047">1047</a>             <strong>if</strong> (Date.<strong>class</strong>.isAssignableFrom(c)) {
<a name="1048" href="#1048">1048</a>                 lastModified = ((Date)lm).getTime();
<a name="1049" href="#1049">1049</a>             } <strong>else</strong> <strong>if</strong> (Long.<strong>class</strong>.isAssignableFrom(c)) {
<a name="1050" href="#1050">1050</a>                 lastModified = ((Long)lm);
<a name="1051" href="#1051">1051</a>             } <strong>else</strong> <strong>if</strong> (String.<strong>class</strong>.isAssignableFrom(c)) {
<a name="1052" href="#1052">1052</a>                 <strong>try</strong> {
<a name="1053" href="#1053">1053</a>                     lastModified = <strong>new</strong> Long((String)lm);
<a name="1054" href="#1054">1054</a>                 } <strong>catch</strong> (NumberFormatException e) {
<a name="1055" href="#1055">1055</a>                     <em class="comment">// nothing to do here</em>
<a name="1056" href="#1056">1056</a>                 }
<a name="1057" href="#1057">1057</a>             } <strong>else</strong> {
<a name="1058" href="#1058">1058</a>                 log.warn(<span class="string">"Unknown type returned for 'lastModified' (not Date, Long, String): "</span> + lm.getClass() + <span class="string">", using the default value of current time instead"</span>);
<a name="1059" href="#1059">1059</a>             }
<a name="1060" href="#1060">1060</a>         }
<a name="1061" href="#1061">1061</a>         <strong>return</strong> lastModified;
<a name="1062" href="#1062">1062</a>     }
<a name="1063" href="#1063">1063</a> 
<a name="1064" href="#1064">1064</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

